API endpoints

Solid fuel boilers

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Package of a solid fuel boiler, supplementary heaters, temperature controls and solar devices: arrow image

Path

/api/v1/solid-fuel-boilers/package-solid-fuel-boiler/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+++ A++ A+ A B C D	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Package of a solid fuel boiler, supplementary heaters, temperature controls and solar devices: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 210mm x 297mm when printed.

Path

/api/v1/solid-fuel-boilers/package-solid-fuel-boiler/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
boilerEfficiencyRating	Energy efficiency class of the solid fuel boiler. Must be one of: A+++ A++ A+ A B C D E F G	String
solarCollector	Does this package include a solar collector?	Boolean
hotWaterStorageTank	Does this package include a hot water storage tank?	Boolean
temperatureControl	Does this package include a temperature control?	Boolean
spaceHeater	Does this package include a supplementary space heater?	Boolean
packageEfficiencyRating	Energy efficiency class of the package of a solid fuel boiler, supplementary heaters, temperature controls and solar devices. Must be one of: A+++ A++ A+ A B C D E F G	String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "boilerEfficiencyRating": "A+++", "solarCollector": true, "hotWaterStorageTank": true, "temperatureControl": true, "spaceHeater": true, "packageEfficiencyRating": "A+++" }

Solid fuel boilers: arrow image

Path

/api/v1/solid-fuel-boilers/solid-fuel-boilers/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+++ A++ A+ A B C D	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Solid fuel boilers: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/solid-fuel-boilers/solid-fuel-boilers/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency class. Must be one of: A+++ A++ A+ A B C D	String
ratedHeatOutput	The rated heat output in kW. This may be up to 2 digits long.	Integer
combination	Is this model a combination boiler?	Boolean
cogeneration	Is this model a cogeneration boiler?	Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "ratedHeatOutput": 1, "combination": true, "cogeneration": true }